home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / include / accessibility / nsIAccessibleRetrieval.h < prev    next >
C/C++ Source or Header  |  2006-05-08  |  11KB  |  222 lines
  1. /*
  2.  * DO NOT EDIT.  THIS FILE IS GENERATED FROM nsIAccessibleRetrieval.idl
  3.  */
  4.  
  5. #ifndef __gen_nsIAccessibleRetrieval_h__
  6. #define __gen_nsIAccessibleRetrieval_h__
  7.  
  8.  
  9. #ifndef __gen_nsISupports_h__
  10. #include "nsISupports.h"
  11. #endif
  12.  
  13. /* For IDL files that don't want to include root IDL files. */
  14. #ifndef NS_NO_VTABLE
  15. #define NS_NO_VTABLE
  16. #endif
  17. class nsIDOMNode; /* forward declaration */
  18.  
  19. class nsIAccessible; /* forward declaration */
  20.  
  21. class nsIWeakReference; /* forward declaration */
  22.  
  23. class nsIPresShell; /* forward declaration */
  24.  
  25. class nsIDOMWindow; /* forward declaration */
  26.  
  27. class nsIAccessNode; /* forward declaration */
  28.  
  29.  
  30. /* starting interface:    nsIAccessibleRetrieval */
  31. #define NS_IACCESSIBLERETRIEVAL_IID_STR "663ca4a8-d219-4000-925d-d8f66406b626"
  32.  
  33. #define NS_IACCESSIBLERETRIEVAL_IID \
  34.   {0x663ca4a8, 0xd219, 0x4000, \
  35.     { 0x92, 0x5d, 0xd8, 0xf6, 0x64, 0x06, 0xb6, 0x26 }}
  36.  
  37. /**
  38.  * An interface for in-process accessibility clients
  39.  * wishing to get an nsIAccessible or nsIAccessNode for
  40.  * a given DOM node.
  41.  * More documentation at:
  42.  *   http://www.mozilla.org/projects/ui/accessibility
  43.  *
  44.  * @status UNDER_REVIEW
  45.  */
  46. class NS_NO_VTABLE nsIAccessibleRetrieval : public nsISupports {
  47.  public: 
  48.  
  49.   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IACCESSIBLERETRIEVAL_IID)
  50.  
  51.   /**
  52.    * Return an nsIAccessible for a DOM node in pres shell 0.
  53.    * Create a new accessible of the appropriate type if necessary,
  54.    * or use one from the accessibility cache if it already exists.
  55.    * @param aNode The DOM node to get an accessible for.
  56.    * @return The nsIAccessible for the given DOM node.
  57.    */
  58.   /* nsIAccessible getAccessibleFor (in nsIDOMNode aNode); */
  59.   NS_IMETHOD GetAccessibleFor(nsIDOMNode *aNode, nsIAccessible **_retval) = 0;
  60.  
  61.   /**
  62.    * Return an nsIAccessible for a DOM node in pres shell for this DOM window.
  63.    * Create a new accessible of the appropriate type if necessary,
  64.    * or use one from the accessibility cache if it already exists.
  65.    * @param aNode   The DOM node to get an accessible for.
  66.    * @param aDOMWin The DOM window containing the node.
  67.    * @return The nsIAccessible for the given DOM node.
  68.    */
  69.   /* nsIAccessible getAccessibleInWindow (in nsIDOMNode aNode, in nsIDOMWindow aDOMWin); */
  70.   NS_IMETHOD GetAccessibleInWindow(nsIDOMNode *aNode, nsIDOMWindow *aDOMWin, nsIAccessible **_retval) = 0;
  71.  
  72.   /**
  73.    * Return an nsIAccessible for a DOM node in the given weak shell.
  74.    * Create a new accessible of the appropriate type if necessary,
  75.    * or use one from the accessibility cache if it already exists.
  76.    * @param aNode      The DOM node to get an accessible for.
  77.    * @param aPresShell The presentation shell which contains layout info for the DOM node.
  78.    * @return The nsIAccessible for the given DOM node.
  79.    */
  80.   /* nsIAccessible getAccessibleInWeakShell (in nsIDOMNode aNode, in nsIWeakReference aPresShell); */
  81.   NS_IMETHOD GetAccessibleInWeakShell(nsIDOMNode *aNode, nsIWeakReference *aPresShell, nsIAccessible **_retval) = 0;
  82.  
  83.   /**
  84.    * Return an nsIAccessible for a DOM node in the given pres shell.
  85.    * Create a new accessible of the appropriate type if necessary,
  86.    * or use one from the accessibility cache if it already exists.
  87.    * @param aNode      The DOM node to get an accessible for.
  88.    * @param aPresShell The presentation shell which contains layout info for the DOM node.
  89.    * @return The nsIAccessible for the given DOM node.
  90.    */
  91.   /* nsIAccessible getAccessibleInShell (in nsIDOMNode aNode, in nsIPresShell aPresShell); */
  92.   NS_IMETHOD GetAccessibleInShell(nsIDOMNode *aNode, nsIPresShell *aPresShell, nsIAccessible **_retval) = 0;
  93.  
  94.   /**
  95.     * Return an nsIAccessNode for an already created DOM node in the given weak shell.
  96.     * Does not create a new one -- only returns cached access nodes.
  97.     * @param aNode      The DOM node to get an access node for.
  98.     * @param aPresShell The presentation shell which contains layout info for the DOM node.
  99.     * @return The nsIAccessNode for the given DOM node or null if
  100.     *         an access node does not already exist for this DOM node.
  101.     */
  102.   /* nsIAccessNode getCachedAccessNode (in nsIDOMNode aNode, in nsIWeakReference aShell); */
  103.   NS_IMETHOD GetCachedAccessNode(nsIDOMNode *aNode, nsIWeakReference *aShell, nsIAccessNode **_retval) = 0;
  104.  
  105.   /**
  106.     * Return an nsIAccessible for an already created DOM node in the given weak shell.
  107.     * Does not create a new one -- only returns cached accessibles.
  108.     * @param aNode      The DOM node to get an accessible for.
  109.     * @param aPresShell The presentation shell which contains layout info for the DOM node.
  110.     * @return The nsIAccessible for the given DOM node or null if
  111.     *         an accessible does not already exist for this DOM node.
  112.     */
  113.   /* nsIAccessible getCachedAccessible (in nsIDOMNode aNode, in nsIWeakReference aShell); */
  114.   NS_IMETHOD GetCachedAccessible(nsIDOMNode *aNode, nsIWeakReference *aShell, nsIAccessible **_retval) = 0;
  115.  
  116. };
  117.  
  118. /* Use this macro when declaring classes that implement this interface. */
  119. #define NS_DECL_NSIACCESSIBLERETRIEVAL \
  120.   NS_IMETHOD GetAccessibleFor(nsIDOMNode *aNode, nsIAccessible **_retval); \
  121.   NS_IMETHOD GetAccessibleInWindow(nsIDOMNode *aNode, nsIDOMWindow *aDOMWin, nsIAccessible **_retval); \
  122.   NS_IMETHOD GetAccessibleInWeakShell(nsIDOMNode *aNode, nsIWeakReference *aPresShell, nsIAccessible **_retval); \
  123.   NS_IMETHOD GetAccessibleInShell(nsIDOMNode *aNode, nsIPresShell *aPresShell, nsIAccessible **_retval); \
  124.   NS_IMETHOD GetCachedAccessNode(nsIDOMNode *aNode, nsIWeakReference *aShell, nsIAccessNode **_retval); \
  125.   NS_IMETHOD GetCachedAccessible(nsIDOMNode *aNode, nsIWeakReference *aShell, nsIAccessible **_retval); 
  126.  
  127. /* Use this macro to declare functions that forward the behavior of this interface to another object. */
  128. #define NS_FORWARD_NSIACCESSIBLERETRIEVAL(_to) \
  129.   NS_IMETHOD GetAccessibleFor(nsIDOMNode *aNode, nsIAccessible **_retval) { return _to GetAccessibleFor(aNode, _retval); } \
  130.   NS_IMETHOD GetAccessibleInWindow(nsIDOMNode *aNode, nsIDOMWindow *aDOMWin, nsIAccessible **_retval) { return _to GetAccessibleInWindow(aNode, aDOMWin, _retval); } \
  131.   NS_IMETHOD GetAccessibleInWeakShell(nsIDOMNode *aNode, nsIWeakReference *aPresShell, nsIAccessible **_retval) { return _to GetAccessibleInWeakShell(aNode, aPresShell, _retval); } \
  132.   NS_IMETHOD GetAccessibleInShell(nsIDOMNode *aNode, nsIPresShell *aPresShell, nsIAccessible **_retval) { return _to GetAccessibleInShell(aNode, aPresShell, _retval); } \
  133.   NS_IMETHOD GetCachedAccessNode(nsIDOMNode *aNode, nsIWeakReference *aShell, nsIAccessNode **_retval) { return _to GetCachedAccessNode(aNode, aShell, _retval); } \
  134.   NS_IMETHOD GetCachedAccessible(nsIDOMNode *aNode, nsIWeakReference *aShell, nsIAccessible **_retval) { return _to GetCachedAccessible(aNode, aShell, _retval); } 
  135.  
  136. /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
  137. #define NS_FORWARD_SAFE_NSIACCESSIBLERETRIEVAL(_to) \
  138.   NS_IMETHOD GetAccessibleFor(nsIDOMNode *aNode, nsIAccessible **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetAccessibleFor(aNode, _retval); } \
  139.   NS_IMETHOD GetAccessibleInWindow(nsIDOMNode *aNode, nsIDOMWindow *aDOMWin, nsIAccessible **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetAccessibleInWindow(aNode, aDOMWin, _retval); } \
  140.   NS_IMETHOD GetAccessibleInWeakShell(nsIDOMNode *aNode, nsIWeakReference *aPresShell, nsIAccessible **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetAccessibleInWeakShell(aNode, aPresShell, _retval); } \
  141.   NS_IMETHOD GetAccessibleInShell(nsIDOMNode *aNode, nsIPresShell *aPresShell, nsIAccessible **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetAccessibleInShell(aNode, aPresShell, _retval); } \
  142.   NS_IMETHOD GetCachedAccessNode(nsIDOMNode *aNode, nsIWeakReference *aShell, nsIAccessNode **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCachedAccessNode(aNode, aShell, _retval); } \
  143.   NS_IMETHOD GetCachedAccessible(nsIDOMNode *aNode, nsIWeakReference *aShell, nsIAccessible **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCachedAccessible(aNode, aShell, _retval); } 
  144.  
  145. #if 0
  146. /* Use the code below as a template for the implementation class for this interface. */
  147.  
  148. /* Header file */
  149. class nsAccessibleRetrieval : public nsIAccessibleRetrieval
  150. {
  151. public:
  152.   NS_DECL_ISUPPORTS
  153.   NS_DECL_NSIACCESSIBLERETRIEVAL
  154.  
  155.   nsAccessibleRetrieval();
  156.  
  157. private:
  158.   ~nsAccessibleRetrieval();
  159.  
  160. protected:
  161.   /* additional members */
  162. };
  163.  
  164. /* Implementation file */
  165. NS_IMPL_ISUPPORTS1(nsAccessibleRetrieval, nsIAccessibleRetrieval)
  166.  
  167. nsAccessibleRetrieval::nsAccessibleRetrieval()
  168. {
  169.   /* member initializers and constructor code */
  170. }
  171.  
  172. nsAccessibleRetrieval::~nsAccessibleRetrieval()
  173. {
  174.   /* destructor code */
  175. }
  176.  
  177. /* nsIAccessible getAccessibleFor (in nsIDOMNode aNode); */
  178. NS_IMETHODIMP nsAccessibleRetrieval::GetAccessibleFor(nsIDOMNode *aNode, nsIAccessible **_retval)
  179. {
  180.     return NS_ERROR_NOT_IMPLEMENTED;
  181. }
  182.  
  183. /* nsIAccessible getAccessibleInWindow (in nsIDOMNode aNode, in nsIDOMWindow aDOMWin); */
  184. NS_IMETHODIMP nsAccessibleRetrieval::GetAccessibleInWindow(nsIDOMNode *aNode, nsIDOMWindow *aDOMWin, nsIAccessible **_retval)
  185. {
  186.     return NS_ERROR_NOT_IMPLEMENTED;
  187. }
  188.  
  189. /* nsIAccessible getAccessibleInWeakShell (in nsIDOMNode aNode, in nsIWeakReference aPresShell); */
  190. NS_IMETHODIMP nsAccessibleRetrieval::GetAccessibleInWeakShell(nsIDOMNode *aNode, nsIWeakReference *aPresShell, nsIAccessible **_retval)
  191. {
  192.     return NS_ERROR_NOT_IMPLEMENTED;
  193. }
  194.  
  195. /* nsIAccessible getAccessibleInShell (in nsIDOMNode aNode, in nsIPresShell aPresShell); */
  196. NS_IMETHODIMP nsAccessibleRetrieval::GetAccessibleInShell(nsIDOMNode *aNode, nsIPresShell *aPresShell, nsIAccessible **_retval)
  197. {
  198.     return NS_ERROR_NOT_IMPLEMENTED;
  199. }
  200.  
  201. /* nsIAccessNode getCachedAccessNode (in nsIDOMNode aNode, in nsIWeakReference aShell); */
  202. NS_IMETHODIMP nsAccessibleRetrieval::GetCachedAccessNode(nsIDOMNode *aNode, nsIWeakReference *aShell, nsIAccessNode **_retval)
  203. {
  204.     return NS_ERROR_NOT_IMPLEMENTED;
  205. }
  206.  
  207. /* nsIAccessible getCachedAccessible (in nsIDOMNode aNode, in nsIWeakReference aShell); */
  208. NS_IMETHODIMP nsAccessibleRetrieval::GetCachedAccessible(nsIDOMNode *aNode, nsIWeakReference *aShell, nsIAccessible **_retval)
  209. {
  210.     return NS_ERROR_NOT_IMPLEMENTED;
  211. }
  212.  
  213. /* End of implementation class template. */
  214. #endif
  215.  
  216. // for component registration
  217. // {663CA4A8-D219-4000-925D-D8F66406B626}
  218. #define NS_ACCESSIBLE_RETRIEVAL_CID \
  219. { 0x663ca4a8, 0xd219, 0x4000, { 0x92, 0x5d, 0xd8, 0xf6, 0x64, 0x6, 0xb6, 0x26 } }
  220.  
  221. #endif /* __gen_nsIAccessibleRetrieval_h__ */
  222.